/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.nageoffer.shortlink.admin.common.biz.user;

import com.alibaba.ttl.TransmittableThreadLocal;

import java.util.Optional;

/**
 * 用户上下文
 */
public final class UserContext {

    /**
     * <a href="https://github.com/alibaba/transmittable-thread-local" />
     */
    private static final ThreadLocal<UserInfoDTO> USER_THREAD_LOCAL = new TransmittableThreadLocal<>();

    /**
     * 设置用户至上下文
     *
     * @param user 用户详情信息
     */
    public static void setUser(UserInfoDTO user) {
        USER_THREAD_LOCAL.set(user);
    }

    /**
     * 获取上下文中用户 ID
     *
     * 此方法用于从当前线程局部变量中获取用户信息，并返回用户 ID
     * 主要用于在系统中的各个部分之间传递用户身份信息，而不需要在每个调用中显式传递用户 ID
     * 使用线程局部变量可以避免在多线程环境下对用户信息的误用或混淆
     *
     * @return 用户 ID，如果未找到用户信息，则返回 null
     */
    public static String getUserId() {
        // 从线程局部变量中获取用户信息
        UserInfoDTO userInfoDTO = USER_THREAD_LOCAL.get();
        // 使用 Optional 进行安全的空检查，并获取用户 ID
        return Optional.ofNullable(userInfoDTO).map(UserInfoDTO::getUserId).orElse(null);
    }

    /**
     * 获取上下文中用户名称
     *
     * 该方法用于从当前线程局部变量中获取用户信息，并返回用户名
     * 主要用于在系统中获取当前操作用户的名称，以便在日志记录、审计或其他功能中使用
     *
     * @return 用户名称如果当前上下文中没有用户信息，则返回null
     */
    public static String getUsername() {
        // 从线程局部变量中获取用户信息
        UserInfoDTO userInfoDTO = USER_THREAD_LOCAL.get();
        // 使用Optional处理可能为null的用户信息，以避免空指针异常，并返回用户名或null
        return Optional.ofNullable(userInfoDTO).map(UserInfoDTO::getUsername).orElse(null);
    }

    /**
     * 获取上下文中用户真实姓名
     *
     * 本方法通过ThreadLocal变量USER_THREAD_LOCAL获取当前线程绑定的用户信息，
     * 并返回用户的真实姓名。如果当前线程没有绑定用户信息，则返回null。
     *
     * @return 用户真实姓名
     */
    public static String getRealName() {
        // 获取当前线程绑定的用户信息
        UserInfoDTO userInfoDTO = USER_THREAD_LOCAL.get();
        // 使用Optional处理可能为null的用户信息，避免空指针异常
        return Optional.ofNullable(userInfoDTO).map(UserInfoDTO::getRealName).orElse(null);
    }

    /**
     * 清理用户上下文
     * 该方法用于移除当前线程本地内存中的用户信息
     * 主要目的是在处理用户请求的不同阶段，确保用户信息不会被错误地保留或泄露到其他请求中
     */
    public static void removeUser() {
        USER_THREAD_LOCAL.remove();
    }
}